<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Range query | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="term-level-queries.html" title="Term-level queries">
<link rel="prev" href="query-dsl-prefix-query.html" title="Prefix query">
<link rel="next" href="query-dsl-regexp-query.html" title="Regexp query">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="query-dsl.html">Query DSL</a></span>
»
<span class="breadcrumb-link"><a href="term-level-queries.html">Term-level queries</a></span>
»
<span class="breadcrumb-node">Range query</span>
</div>
<div class="navheader">
<span class="prev">
<a href="query-dsl-prefix-query.html">« Prefix query</a>
</span>
<span class="next">
<a href="query-dsl-regexp-query.html">Regexp query »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="query-dsl-range-query"></a>Range query<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns documents that contain terms within a provided range.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="range-query-ex-request"></a>Example request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The following search returns documents where the <code class="literal">age</code> field contains a term
between <code class="literal">10</code> and <code class="literal">20</code>.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_search
{
    "query": {
        "range" : {
            "age" : {
                "gte" : 10,
                "lte" : 20,
                "boost" : 2.0
            }
        }
    }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/282.console"></div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="range-query-top-level-params"></a>Top-level parameters for <code class="literal">range</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;field&gt;</code>
</span>
</dt>
<dd>
<p>(Required, object) Field you wish to search.</p>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="range-query-field-params"></a>Parameters for <code class="literal">&lt;field&gt;</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">gt</code>
</span>
</dt>
<dd>
(Optional) Greater than.
</dd>
<dt>
<span class="term">
<code class="literal">gte</code>
</span>
</dt>
<dd>
(Optional) Greater than or equal to.
</dd>
<dt>
<span class="term">
<code class="literal">lt</code>
</span>
</dt>
<dd>
(Optional) Less than.
</dd>
<dt>
<span class="term">
<code class="literal">lte</code>
</span>
</dt>
<dd>
(Optional) Less than or equal to.
</dd>
<dt>
<span class="term">
<code class="literal">format</code>
</span>
</dt>
<dd>
<p>(Optional, string) Date format used to convert <code class="literal">date</code> values in the query.</p>
<p>By default, Elasticsearch uses the <a class="xref" href="mapping-date-format.html" title="format">date <code class="literal">format</code></a> provided in the
<code class="literal">&lt;field&gt;</code>'s mapping. This value overrides that mapping format.</p>
<p>For valid syntax, see <a class="xref" href="mapping-date-format.html" title="format"><code class="literal">format</code></a>.</p>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>If a <code class="literal">format</code> and <code class="literal">date</code> value are incomplete, Elasticsearch replaces any missing year,
month, or date component with the start of
<a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix time</a>, which is January 1st, 1970.</p>
<p>For example, if the <code class="literal">format</code> value is <code class="literal">dd</code>, Elasticsearch converts a <code class="literal">gte</code> value of <code class="literal">10</code>
to <code class="literal">1970-01-10T00:00:00.000Z</code>.</p>
</div>
</div>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="querying-range-fields"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">relation</code>
</span>
</dt>
<dd>
<p>(Optional, string) Indicates how the range query matches values for <code class="literal">range</code>
fields. Valid values are:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">INTERSECTS</code> (Default)
</span>
</dt>
<dd>
Matches documents with a range field value that intersects the query’s range.
</dd>
<dt>
<span class="term">
<code class="literal">CONTAINS</code>
</span>
</dt>
<dd>
Matches documents with a range field value that entirely contains the query’s range.
</dd>
<dt>
<span class="term">
<code class="literal">WITHIN</code>
</span>
</dt>
<dd>
Matches documents with a range field value entirely within the query’s range.
</dd>
</dl>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">time_zone</code>
</span>
</dt>
<dd>
<p>(Optional, string)
<a href="https://en.wikipedia.org/wiki/List_of_UTC_time_offsets" class="ulink" target="_top">Coordinated Universal
Time (UTC) offset</a> or
<a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" class="ulink" target="_top">IANA time zone</a>
used to convert <code class="literal">date</code> values in the query to UTC.</p>
<p>Valid values are ISO 8601 UTC offsets, such as <code class="literal">+01:00</code> or -<code class="literal">08:00</code>, and IANA
time zone IDs, such as <code class="literal">America/Los_Angeles</code>.</p>
<p>For an example query using the <code class="literal">time_zone</code> parameter, see
<a class="xref" href="query-dsl-range-query.html#range-query-time-zone" title="Example query using time_zone parameter">Time zone in <code class="literal">range</code> queries</a>.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The <code class="literal">time_zone</code> parameter does <span class="strong strong"><strong>not</strong></span> affect the <a class="xref" href="common-options.html#date-math" title="Date Math">date math</a> value
of <code class="literal">now</code>. <code class="literal">now</code> is always the current system time in UTC.</p>
<p>However, the <code class="literal">time_zone</code> parameter does convert dates calculated using <code class="literal">now</code> and
<a class="xref" href="common-options.html#date-math" title="Date Math">date math rounding</a>. For example, the <code class="literal">time_zone</code> parameter will
convert a value of <code class="literal">now/d</code>.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">boost</code>
</span>
</dt>
<dd>
<p>(Optional, float) Floating point number used to decrease or increase the
<a class="xref" href="query-filter-context.html#relevance-scores" title="Relevance scores">relevance scores</a> of a query. Defaults to <code class="literal">1.0</code>.</p>
<p>You can use the <code class="literal">boost</code> parameter to adjust relevance scores for searches
containing two or more queries.</p>
<p>Boost values are relative to the default value of <code class="literal">1.0</code>. A boost value between
<code class="literal">0</code> and <code class="literal">1.0</code> decreases the relevance score. A value greater than <code class="literal">1.0</code>
increases the relevance score.</p>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="range-query-notes"></a>Notes<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="ranges-on-text-and-keyword"></a>Using the <code class="literal">range</code> query with <code class="literal">text</code> and <code class="literal">keyword</code> fields<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h4>
</div></div></div>
<p>Range queries on <a class="xref" href="text.html" title="Text datatype"><code class="literal">text</code></a> or <a class="xref" href="keyword.html" title="Keyword datatype"><code class="literal">keyword</code></a> files will not be executed if
<a class="xref" href="query-dsl.html#query-dsl-allow-expensive-queries"><code class="literal">search.allow_expensive_queries</code></a> is set to false.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="ranges-on-dates"></a>Using the <code class="literal">range</code> query with <code class="literal">date</code> fields<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h4>
</div></div></div>
<p>When the <code class="literal">&lt;field&gt;</code> parameter is a <a class="xref" href="date.html" title="Date datatype"><code class="literal">date</code></a> field datatype, you can use
<a class="xref" href="common-options.html#date-math" title="Date Math">date math</a> with the following parameters:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<code class="literal">gt</code>
</li>
<li class="listitem">
<code class="literal">gte</code>
</li>
<li class="listitem">
<code class="literal">lt</code>
</li>
<li class="listitem">
<code class="literal">lte</code>
</li>
</ul>
</div>
<p>For example, the following search returns documents where the <code class="literal">timestamp</code> field
contains a date between today and yesterday.</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_search
{
    "query": {
        "range" : {
            "timestamp" : {
                "gte" : "now-1d/d",
                "lt" :  "now/d"
            }
        }
    }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/283.console"></div>
<div class="section">
<div class="titlepage"><div><div>
<h5 class="title">
<a id="range-query-date-math-rounding"></a>Date math and rounding<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h5>
</div></div></div>
<p>Elasticsearch rounds <a class="xref" href="common-options.html#date-math" title="Date Math">date math</a> values in parameters as follows:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">gt</code>
</span>
</dt>
<dd>
<p>Rounds up to the first millisecond not covered by the rounded date.</p>
<p>For example, <code class="literal">2014-11-18||/M</code> rounds up to <code class="literal">2014-12-01T00:00:00.000</code>, excluding
the entire month of November.</p>
</dd>
<dt>
<span class="term">
<code class="literal">gte</code>
</span>
</dt>
<dd>
<p>Rounds down to the first millisecond.</p>
<p>For example, <code class="literal">2014-11-18||/M</code> rounds down to <code class="literal">2014-11-01T00:00:00.000</code>, including
the entire month.</p>
</dd>
<dt>
<span class="term">
<code class="literal">lt</code>
</span>
</dt>
<dd>
<p>Rounds down to the last millisecond before the rounded value.</p>
<p>For example, <code class="literal">2014-11-18||/M</code> rounds down to <code class="literal">2014-10-31T23:59:59.999</code>, excluding
the entire month of November.</p>
</dd>
<dt>
<span class="term">
<code class="literal">lte</code>
</span>
</dt>
<dd>
<p>Rounds up to the latest millisecond in the rounding interval.</p>
<p>For example, <code class="literal">2014-11-18||/M</code> rounds up to <code class="literal">2014-11-30T23:59:59.999</code>, including
the entire month.</p>
</dd>
</dl>
</div>
</div>

</div>

<div class="section">
<div class="titlepage"><div><div>
<h4 class="title">
<a id="range-query-time-zone"></a>Example query using <code class="literal">time_zone</code> parameter<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/query-dsl/range-query.asciidoc">edit</a>
</h4>
</div></div></div>
<p>You can use the <code class="literal">time_zone</code> parameter to convert <code class="literal">date</code> values to UTC using a
UTC offset. For example:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_search
{
  "query": {
    "range": {
      "timestamp": {
        "time_zone": "+01:00",        <a id="CO63-1"></a><i class="conum" data-value="1"></i>
        "gte": "2020-01-01T00:00:00", <a id="CO63-2"></a><i class="conum" data-value="2"></i>
        "lte": "now"                  <a id="CO63-3"></a><i class="conum" data-value="3"></i>
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/284.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO63-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Indicates that <code class="literal">date</code> values use a UTC offset of <code class="literal">+01:00</code>.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO63-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>With a UTC offset of <code class="literal">+01:00</code>, Elasticsearch converts this date to
<code class="literal">2019-12-31T23:00:00 UTC</code>.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO63-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>The <code class="literal">time_zone</code> parameter does not affect the <code class="literal">now</code> value.</p>
</td>
</tr>
</table>
</div>
</div>

</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="query-dsl-prefix-query.html">« Prefix query</a>
</span>
<span class="next">
<a href="query-dsl-regexp-query.html">Regexp query »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
